Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PXY-860 Add metadata to Plugins #67

Merged
merged 5 commits into from
Jul 12, 2023
Merged

PXY-860 Add metadata to Plugins #67

merged 5 commits into from
Jul 12, 2023

Conversation

framiere
Copy link
Collaborator

@framiere framiere commented Jul 11, 2023

The objective is to be able to give more context for each plugin.
Any UI wanted to surface these plugins will need a way to get some metadata about them.

Copy link
Contributor

@fteychene fteychene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a description of the change ?

Also a question regarding format and loading with multiple plugins


default List<String> examples() {
try {
return List.of(resourceAsString("/META-INF/services/example.json"));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Configuration is done by yaml from configuration file in gateway. Maybe we should provide multiple configuration files.

Also if multiple plugins (let's say 2) are loaded in the classpath and each ref a /META-INF/services/example.json what happen ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, addressed here: 84033e0

@framiere
Copy link
Collaborator Author

@fteychene good?

Copy link
Contributor

@thomaskwscott thomaskwscott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@framiere framiere merged commit 7f1fe4b into main Jul 12, 2023
@Stu-conduktor
Copy link
Contributor

@framiere - what's the behaviour for;

  1. Two differently configured plugins generated from the same interceptor? (I believe it returns the generic example, versus your configuration?)
  2. Can we add this to the API docs if it's in the main build and official?

@framiere
Copy link
Collaborator Author

  1. There's no more examples, example should live in doc (Francois is right)
  2. yes when we'll release 0.5.0 (we are currently in 0.5.0-SNAPSHOT)

@thomaskwscott
Copy link
Contributor

  1. There's no more examples, example should live in doc (Francois is right)
  2. yes when we'll release 0.5.0 (we are currently in 0.5.0-SNAPSHOT)

If the purpose of this is for the UI then it must contain an example JSON, otherwise it's useless imo. Can we do another PR that covers this?

@sderosiaux sderosiaux deleted the framiere/PXY-860 branch February 14, 2024 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants